Creating a Return

To create a return, you can simply create a receive with the added subtype set to "RET". This lets the warehouse know that this receive is a return. The return subtype can be used to differentiate the warehouse handling process for supplier inventory compared to return inventory.

The following example provides the required information for creating a warehouse receive with a subtype of return:

Example Request

{
  "warehouseCode": "LAW",
  "primaryReference": "RET12345",
  "secondaryReference": "RMA98765",
  "subtype": "RET",
  "eta": "2023-05-01T10:00:00+00:00",
  "transportReference": "1Z999999999",
  "shipFromAddress": {
    "address": {
      "organization": "Customer Returns",
      "addressLine1": "789 Return Lane",
      "country": "USA",
      "state": "TX",
      "city": "Dallas",
      "postalCode": "75201"
    },
    "contact": {
      "personName": "Jane Smith",
      "phoneNumber": "214-555-0123",
      "emailAddress": "jane.smith@email.com"
    }
  },
  "receiveLines": [
    {
      "externalLineReference": "RMA-001",
      "productCode": "APL-IPH-13PRO-256-GRPH",
      "quantity": 1,
      "quantityUnit": "UNT"
    }
  ],
  "additionalReferences": [
    {
      "key": "RMA",
      "value": "RMA98765"
    }
  ]
}

The same GET methods and webhooks used for receives can also be used for returns. To retrieve updates for returns, you can follow the same approach as described in the receive.